Fetch Authorizations

Consultar uma autorização específica

Use este endpoint para consultar informações sobre uma autorização de Pix Automático.

Consultar todas as autorizações

Este endpoint consulta todas as autorizações, enviadas ou recebidas.

Requisição

GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations'

Cabeçalhos

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave da API

Parâmetros de Query

Nome	Tipo	Descrição
Flow	number	Obrigatório. 0 para pagador ou 1 para recebedor
BeneficiaryDocument	string	Opcional. Documento do recebedor (máx. 14 caracteres)
BeneficiaryAccount	string	Opcional. Conta do recebedor
PayerPersonType	number	Opcional. 0 para Pessoa Física (CPF) ou 1 para Pessoa Jurídica (CNPJ)
PayerDocument	string	Opcional. Documento do pagador (CPF/CNPJ - máx. 14 caracteres)
PayerAgencyNumber	string	Opcional. Agência do pagador (máx. 4 caracteres)
PayerAccountNumber	string	Opcional. Número da conta do pagador (máx. 20 caracteres)
AuthorizationResult	string	Opcional. Resultado da autorização
Status	string	Opcional. Status da autorização
RecurrenceUpdatedDateTimeFrom	date	Opcional. Filtrar por data/hora de atualização a partir de (formato DateTime)
RecurrenceUpdatedDateTimeTo	date	Opcional. Filtrar por data/hora de atualização até (formato DateTime)
Page	number	Opcional. Número da página (Padrão: 1). Deve ser um número positivo
PageSize	number	Opcional. Quantidade de resultados por página (Padrão: 50, Máx: 100)
RecurrenceStartDateFrom	date	Opcional. Filtrar por data de início da recorrência a partir de (formato DateOnly)
RecurrenceStartDateTo	date	Opcional. Filtrar por data de início da recorrência até (formato DateOnly)
RecurrenceCreatedDateTimeFrom	date	Opcional. Filtrar por data/hora de criação da recorrência a partir de (formato DateTime)
RecurrenceCreatedDateTimeTo	date	Opcional. Filtrar por data/hora de criação da recorrência até (formato DateTime)

Resposta

O status code 200 indica sucesso na consulta.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
    "data": [
        {
            "id": "e45a2b8c-9c3f-412d-a78b-3e5f1d9a0c2b",
            "flow": "RECEIVER",
            "recurrenceId": "RR3822895720250530oouu9uhf473",
            "journey": 2,
            "frequencyType": "ANNUAL",
            "authorizationResult": "AUTHORIZED",
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "0001",
                "accountType": "CURRENT",
                "accountNumber": "98765"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountType": "PAYMENT",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "contractDescription": "Assinatura Anual",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "recurrenceEndDate": "2026-07-02T00:00:00",
            "recurrenceCreatedAt": "2025-07-08T15:32:35.532Z",
            "requestCreatedAt": "2025-07-08T15:32:35.838Z",
            "requestExpirationAt": "2025-07-08T16:00:00.000Z",
            "recurrenceAuthorizedAt": "2025-07-08T15:32:35.532Z",
            "lastInstructionAt": "2025-07-08T15:32:36.208Z",
            "amount": 100.00,
            "payerMaxAmount": 150.00,
            "minPayerMaxAmount": 100.00,
            "status": "ACTIVE",
            "reasonRejection": null,
            "beneficiaryReconciliationId": "REC-123",
            "cityIbgeCode": "2800308"
        },
        {
            "id": "f56b3c9d-0d4e-523e-b89c-4f6e2e0b1d3c",
            "flow": "RECEIVER",
            "recurrenceId": "RR3822895720250530oouu9uhf579",
            "journey": 2,
            "frequencyType": "ANNUAL",
            "authorizationResult": "CANCELLED",
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "0001",
                "accountType": "CURRENT",
                "accountNumber": "98765"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountType": "PAYMENT",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "contractDescription": "Assinatura Anual",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "recurrenceEndDate": "2026-07-02T00:00:00",
            "recurrenceCreatedAt": "2025-07-04T12:31:54.899Z",
            "requestCreatedAt": "2025-07-04T12:31:55.216Z",
            "requestExpirationAt": "2025-07-04T13:00:00.000Z",
            "recurrenceAuthorizedAt": "2025-07-04T12:31:54.899Z",
            "lastInstructionAt": "2025-07-04T12:31:55.563Z",
            "amount": 100.00,
            "payerMaxAmount": 150.00,
            "minPayerMaxAmount": 100.00,
            "status": "CANCELLED",
            "reasonRejection": null,
            "beneficiaryReconciliationId": "REC-456",
            "cityIbgeCode": "2800308"
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageSize": 50,
        "totalPages": 1,
        "totalRecords": 2,
        "hasPreviousPage": false,
        "hasNextPage": false
    }
}